<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Tekdaqc Firmware: TelnetServer_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customstyle.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Tekdaqc Firmware
   &#160;<span id="projectnumber">1.0.2.0</span>
   </div>
   <div id="projectbrief">The firmware of the Tekdaqc.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_telnet_server__t.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">TelnetServer_t Struct Reference<div class="ingroups"><a class="el" href="group__telnet__server.html">Telnet Server</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Data structure to hold the state of the Telnet server. Contains all of the necessary state variables to impliment the Telnet server. Direct manipulation of these members is not recommended as it may leave the server in an inconsistent state. Instead, helper methods are provided which will ensure that all necessary operations occur as a result of any change.  
 <a href="struct_telnet_server__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a9a80d626b495810428f2f14b4dae6ecb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_telnet_server__t.html#a9a80d626b495810428f2f14b4dae6ecb">halt</a></td></tr>
<tr class="separator:a9a80d626b495810428f2f14b4dae6ecb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8010cffb8a33a3f5d540dcd6ef57a7b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__telnet__server.html#ga6a34decdb77d8c9df8ead5420ea8d326">TelnetState_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_telnet_server__t.html#a8010cffb8a33a3f5d540dcd6ef57a7b6">state</a></td></tr>
<tr class="separator:a8010cffb8a33a3f5d540dcd6ef57a7b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad311f0113656983251afddd4b62e758e"><td class="memItemLeft" align="right" valign="top">volatile unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_telnet_server__t.html#ad311f0113656983251afddd4b62e758e">outstanding</a></td></tr>
<tr class="separator:ad311f0113656983251afddd4b62e758e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65bcef02b557e4aa1e0f04cc2ae743b9"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_telnet_server__t.html#a65bcef02b557e4aa1e0f04cc2ae743b9">close</a></td></tr>
<tr class="separator:a65bcef02b557e4aa1e0f04cc2ae743b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2153306d0b7676b5fbe604eb2d5d8dd9"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_telnet_server__t.html#a2153306d0b7676b5fbe604eb2d5d8dd9">buffer</a> [<a class="el" href="group__telnet__server.html#gae9088b6c383afeff8d58098f141afbd3">TELNET_BUFFER_LENGTH</a>]</td></tr>
<tr class="separator:a2153306d0b7676b5fbe604eb2d5d8dd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41a73345f82ef7f47757b13967fcc815"><td class="memItemLeft" align="right" valign="top">volatile unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_telnet_server__t.html#a41a73345f82ef7f47757b13967fcc815">length</a></td></tr>
<tr class="separator:a41a73345f82ef7f47757b13967fcc815"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22aa9df37278d5baef90c6738214d9a1"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_telnet_server__t.html#a22aa9df37278d5baef90c6738214d9a1">recvBuffer</a> [<a class="el" href="group__telnet__server.html#gae9088b6c383afeff8d58098f141afbd3">TELNET_BUFFER_LENGTH</a>]</td></tr>
<tr class="separator:a22aa9df37278d5baef90c6738214d9a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac07efa3d17c62c9b958f4324b78ebf55"><td class="memItemLeft" align="right" valign="top">volatile unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_telnet_server__t.html#ac07efa3d17c62c9b958f4324b78ebf55">recvWrite</a></td></tr>
<tr class="separator:ac07efa3d17c62c9b958f4324b78ebf55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b9f32d419aaecd74a928bb8286f2a7b"><td class="memItemLeft" align="right" valign="top">volatile unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_telnet_server__t.html#a4b9f32d419aaecd74a928bb8286f2a7b">recvRead</a></td></tr>
<tr class="separator:a4b9f32d419aaecd74a928bb8286f2a7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d8c5f5eed3154f7848c3a2ac9a9863a"><td class="memItemLeft" align="right" valign="top">struct tcp_pcb *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_telnet_server__t.html#a7d8c5f5eed3154f7848c3a2ac9a9863a">pcb</a></td></tr>
<tr class="separator:a7d8c5f5eed3154f7848c3a2ac9a9863a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8616416f9e7e002fe8f0a98f0ed71fd5"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_telnet_server__t.html#a8616416f9e7e002fe8f0a98f0ed71fd5">previous</a></td></tr>
<tr class="separator:a8616416f9e7e002fe8f0a98f0ed71fd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="_telnet_server_8h_source.html#l00159">159</a> of file <a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a2153306d0b7676b5fbe604eb2d5d8dd9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned char buffer[<a class="el" href="group__telnet__server.html#gae9088b6c383afeff8d58098f141afbd3">TELNET_BUFFER_LENGTH</a>]</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A buffer used to construct a packet of data to be transmitted to the telnet client. </p>

<p>Definition at line <a class="el" href="_telnet_server_8h_source.html#l00164">164</a> of file <a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a>.</p>

</div>
</div>
<a class="anchor" id="a65bcef02b557e4aa1e0f04cc2ae743b9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned long close</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A value that is non-zero when the telnet connection should be closed down. </p>

<p>Definition at line <a class="el" href="_telnet_server_8h_source.html#l00163">163</a> of file <a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a>.</p>

</div>
</div>
<a class="anchor" id="a9a80d626b495810428f2f14b4dae6ecb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int halt</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Halt signal when the lwIP TCP/IP stack has detected an error </p>

<p>Definition at line <a class="el" href="_telnet_server_8h_source.html#l00160">160</a> of file <a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a>.</p>

</div>
</div>
<a class="anchor" id="a41a73345f82ef7f47757b13967fcc815"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">volatile unsigned long length</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The number of bytes of valid data in the telnet packet buffer. </p>

<p>Definition at line <a class="el" href="_telnet_server_8h_source.html#l00165">165</a> of file <a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a>.</p>

</div>
</div>
<a class="anchor" id="ad311f0113656983251afddd4b62e758e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">volatile unsigned long outstanding</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A count of the number of bytes that have been transmitted but have not yet been ACKed. </p>

<p>Definition at line <a class="el" href="_telnet_server_8h_source.html#l00162">162</a> of file <a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a>.</p>

</div>
</div>
<a class="anchor" id="a7d8c5f5eed3154f7848c3a2ac9a9863a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct tcp_pcb* pcb</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A pointer to the telnet session PCB data structure. </p>

<p>Definition at line <a class="el" href="_telnet_server_8h_source.html#l00171">171</a> of file <a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a>.</p>

</div>
</div>
<a class="anchor" id="a8616416f9e7e002fe8f0a98f0ed71fd5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned char previous</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The character most recently received via the telnet interface. This is used to convert CR/LF sequences into a simple CR sequence. </p>

<p>Definition at line <a class="el" href="_telnet_server_8h_source.html#l00172">172</a> of file <a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a>.</p>

</div>
</div>
<a class="anchor" id="a22aa9df37278d5baef90c6738214d9a1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned char recvBuffer[<a class="el" href="group__telnet__server.html#gae9088b6c383afeff8d58098f141afbd3">TELNET_BUFFER_LENGTH</a>]</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A buffer used to receive data from the telnet connection. </p>

<p>Definition at line <a class="el" href="_telnet_server_8h_source.html#l00166">166</a> of file <a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a>.</p>

</div>
</div>
<a class="anchor" id="a4b9f32d419aaecd74a928bb8286f2a7b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">volatile unsigned long recvRead</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The offset into g_pucTelnetRecvRead of the next location to be read from the buffer. The buffer is empty if this value is equal to g_ulTelnetRecvWrite. </p>

<p>Definition at line <a class="el" href="_telnet_server_8h_source.html#l00169">169</a> of file <a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a>.</p>

</div>
</div>
<a class="anchor" id="ac07efa3d17c62c9b958f4324b78ebf55"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">volatile unsigned long recvWrite</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The offset into g_pucTelnetRecvBuffer of the next location to be written in the buffer. The buffer is full if this value is one less than g_ulTelnetRecvRead (modulo the buffer size). </p>

<p>Definition at line <a class="el" href="_telnet_server_8h_source.html#l00167">167</a> of file <a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a>.</p>

</div>
</div>
<a class="anchor" id="a8010cffb8a33a3f5d540dcd6ef57a7b6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__telnet__server.html#ga6a34decdb77d8c9df8ead5420ea8d326">TelnetState_t</a> state</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The current state of the telnet option parser. </p>

<p>Definition at line <a class="el" href="_telnet_server_8h_source.html#l00161">161</a> of file <a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="_telnet_server_8h_source.html">TelnetServer.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="struct_telnet_server__t.html">TelnetServer_t</a></li>
    <li class="footer">Generated on Mon Jul 28 2014 23:42:42 for Tekdaqc Firmware by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
